Parametre Doğrulaması için JavaScript Decorator'ları: Veri Bütünlüğünü Sağlama

Modern JavaScript geliştirmede, fonksiyonlara ve metotlara aktarılan verilerin bütünlüğünü sağlamak çok önemlidir. Bunu başarmak için güçlü tekniklerden biri, parametre doğrulaması için decorator'ların kullanılmasıdır. Babel aracılığıyla JavaScript'te veya yerel olarak TypeScript'te bulunan bir özellik olan decorator'lar, fonksiyonlara, sınıflara ve özelliklere işlevsellik eklemenin temiz ve zarif bir yolunu sunar. Bu makale, JavaScript decorator'larının dünyasına dalarak, özellikle argüman kontrolündeki uygulamalarına odaklanmakta ve her seviyeden geliştirici için pratik örnekler ve içgörüler sunmaktadır.

JavaScript Decorator'ları Nedir?

Decorator'lar, mevcut bir sınıfa, fonksiyona veya özelliğe dinamik ve statik olarak davranış eklemenize olanak tanıyan bir tasarım desenidir. Esasen, orijinal kodun kendisini değiştirmeden mevcut kodu yeni işlevsellikle "dekore ederler". Bu, yazılım varlıklarının (sınıflar, modüller, fonksiyonlar vb.) genişletmeye açık, ancak değiştirmeye kapalı olması gerektiğini belirten SOLID tasarımının Açık/Kapalı Prensibi'ne uyar.

JavaScript'te decorator'lar, bir sınıf bildirimine, metoda, erişimciye, özelliğe veya parametreye eklenebilen özel bir bildirim türüdür. @expression sözdizimini kullanırlar; burada expression, çalışma zamanında dekore edilmiş bildirim hakkındaki bilgilerle çağrılacak bir fonksiyona karşılık gelmelidir.

JavaScript'te decorator'ları kullanmak için genellikle @babel/plugin-proposal-decorators eklentisi etkinleştirilmiş Babel gibi bir transpiler kullanmanız gerekir. TypeScript, decorator'ları yerel olarak destekler.

Parametre Doğrulaması için Decorator Kullanmanın Faydaları

Parametre doğrulaması için decorator kullanmak birçok avantaj sunar:

• Geliştirilmiş Kod Okunabilirliği: Decorator'lar, doğrulama kurallarını ifade etmenin bildirimsel bir yolunu sunarak kodu anlamayı ve sürdürmeyi kolaylaştırır.
• Azaltılmış Tekrarlayan Kod: Doğrulama mantığını birden fazla fonksiyonda tekrarlamak yerine, decorator'lar bunu bir kez tanımlamanıza ve kod tabanınızda uygulamanıza olanak tanır.
• Artırılmış Kod Yeniden Kullanılabilirliği: Decorator'lar farklı sınıflar ve fonksiyonlar arasında yeniden kullanılabilir, bu da kodun yeniden kullanımını teşvik eder ve fazlalığı azaltır.
• Sorumlulukların Ayrılması: Doğrulama mantığı, fonksiyonun temel iş mantığından ayrılarak daha temiz ve modüler bir kod ortaya çıkarır.
• Merkezi Doğrulama Mantığı: Tüm doğrulama kuralları tek bir yerde tanımlanır, bu da onları güncellemeyi ve sürdürmeyi kolaylaştırır.

Decorator'lar ile Parametre Doğrulaması Uygulama

JavaScript decorator'larını kullanarak parametre doğrulamasını nasıl uygulayacağımızı keşfedelim. Basit bir örnekle başlayıp ardından daha karmaşık senaryolara geçeceğiz.

Temel Örnek: Bir String Parametresini Doğrulama

Bir string parametresi bekleyen bir fonksiyon düşünün. Parametrenin gerçekten bir string olduğundan emin olmak için bir decorator oluşturabiliriz.

function validateString(target: any, propertyKey: string | symbol, parameterIndex: number) {
  let existingParameters: any[] = Reflect.getOwnMetadata('validateParameters', target, propertyKey) || [];
  existingParameters.push({ index: parameterIndex, validator: (value: any) => typeof value === 'string' });
  Reflect.defineMetadata('validateParameters', existingParameters, target, propertyKey);

  const originalMethod = target[propertyKey];

  target[propertyKey] = function (...args: any[]) {
    const metadata = Reflect.getOwnMetadata('validateParameters', target, propertyKey);

    if (metadata) {
      for (const item of metadata) {
        const { index, validator } = item;
        if (!validator(args[index])) {
          throw new Error(`Parameter at index ${index} is invalid`);
        }
      }
    }

    return originalMethod.apply(this, args);
  };
}

function validate(...validators: ((value: any) => boolean)[]) {
  return function (target: any, propertyKey: string | symbol, descriptor: PropertyDescriptor) {
    const originalMethod = descriptor.value;

    descriptor.value = function (...args: any[]) {
      for (let i = 0; i < validators.length; i++) {
        if (!validators[i](args[i])) {
          throw new Error(`Parameter at index ${i} is invalid`);
        }
      }
      return originalMethod.apply(this, args);
    };
  };
}


function isString(value: any): boolean {
  return typeof value === 'string';
}

class Example {
  @validate(isString)
  greet( @validateString name: string) {
    return `Hello, ${name}!`;
  }
}

const example = new Example();

try {
  console.log(example.greet("Alice")); // Output: Hello, Alice!
  // example.greet(123); // Throws an error
} catch (error:any) {
  console.error(error.message);
}

Açıklama:

• validateString decorator'ı, greet metodunun name parametresine uygulanır.
• Metotla ilişkili doğrulama meta verilerini depolamak ve almak için Reflect.defineMetadata ve Reflect.getOwnMetadata kullanır.
• Orijinal metodu çağırmadan önce, doğrulama meta verileri arasında döngü yapar ve her parametreye doğrulayıcı fonksiyonunu uygular.
• Herhangi bir parametre doğrulamayı geçemezse, bir hata fırlatılır.
• validate decorator'ı, parametrelere doğrulayıcıları uygulamak için daha genel ve birleştirilebilir bir yol sunar ve her parametre için birden fazla doğrulayıcının belirtilmesine olanak tanır.
• isString fonksiyonu, bir değerin string olup olmadığını kontrol eden basit bir doğrulayıcıdır.
• Example sınıfı, greet metodunun name parametresini doğrulamak için decorator'ların nasıl kullanılacağını gösterir.

Gelişmiş Örnek: E-posta Formatını Doğrulama

Bir string parametresinin geçerli bir e-posta adresi olduğunu doğrulamak için bir decorator oluşturalım.

function validateEmail(target: any, propertyKey: string | symbol, parameterIndex: number) {
  let existingParameters: any[] = Reflect.getOwnMetadata('validateParameters', target, propertyKey) || [];
  existingParameters.push({ index: parameterIndex, validator: (value: any) => {
    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
    return typeof value === 'string' && emailRegex.test(value);
  } });
  Reflect.defineMetadata('validateParameters', existingParameters, target, propertyKey);

  const originalMethod = target[propertyKey];

  target[propertyKey] = function (...args: any[]) {
    const metadata = Reflect.getOwnMetadata('validateParameters', target, propertyKey);

    if (metadata) {
      for (const item of metadata) {
        const { index, validator } = item;
        if (!validator(args[index])) {
          throw new Error(`Parameter at index ${index} is not a valid email address`);
        }
      }
    }

    return originalMethod.apply(this, args);
  };
}

class User {
  register( @validateEmail email: string) {
    return `Registered with email: ${email}`;
  }
}

const user = new User();

try {
  console.log(user.register("test@example.com")); // Output: Registered with email: test@example.com
  // user.register("invalid-email"); // Throws an error
} catch (error:any) {
  console.error(error.message);
}

Açıklama:

• validateEmail decorator'ı, parametrenin geçerli bir e-posta adresi olup olmadığını kontrol etmek için bir düzenli ifade (regular expression) kullanır.
• Parametre geçerli bir e-posta adresi değilse, bir hata fırlatılır.

Birden Fazla Doğrulayıcıyı Birleştirme

validate decorator'ını ve özel doğrulayıcı fonksiyonlarını kullanarak birden fazla doğrulayıcıyı birleştirebilirsiniz.

function isNotEmptyString(value: any): boolean {
  return typeof value === 'string' && value.trim() !== '';
}

function isPositiveNumber(value: any): boolean {
  return typeof value === 'number' && value > 0;
}

class Product {
  @validate(isNotEmptyString, isPositiveNumber)
  create(name: string, price: number) {
    return `Product created: ${name} - $${price}`;  
  }
}

const product = new Product();

try {
  console.log(product.create("Laptop", 1200)); // Output: Product created: Laptop - $1200
  // product.create("", 0); // Throws an error
} catch (error:any) {
  console.error(error.message);
}

Açıklama:

• isNotEmptyString doğrulayıcısı, bir string'in boşlukları temizlendikten sonra boş olup olmadığını kontrol eder.
• isPositiveNumber doğrulayıcısı, bir değerin pozitif bir sayı olup olmadığını kontrol eder.
• validate decorator'ı, Product sınıfının create metoduna her iki doğrulayıcıyı da uygulamak için kullanılır.

Parametre Doğrulamasında Decorator Kullanımı için En İyi Uygulamalar

Parametre doğrulaması için decorator kullanırken dikkate alınması gereken bazı en iyi uygulamalar şunlardır:

• Decorator'ları Basit Tutun: Decorator'lar doğrulama mantığına odaklanmalı ve karmaşık hesaplamalardan kaçınmalıdır.
• Açık Hata Mesajları Sağlayın: Hata mesajlarının bilgilendirici olduğundan ve geliştiricilerin doğrulama hatalarını anlamalarına yardımcı olduğundan emin olun.
• Anlamlı İsimler Kullanın: Kod okunabilirliğini artırmak için decorator'larınız için açıklayıcı isimler seçin.
• Decorator'larınızı Belgeleyin: Anlaşılmasını ve sürdürülmesini kolaylaştırmak için decorator'larınızın amacını ve kullanımını belgeleyin.
• Performansı Göz Önünde Bulundurun: Decorator'lar işlevsellik eklemenin kolay bir yolunu sunarken, özellikle performansa duyarlı uygulamalarda performans etkilerini göz önünde bulundurun.
• Gelişmiş Tip Güvenliği için TypeScript Kullanın: TypeScript, decorator'lar için yerleşik destek sağlar ve tip güvenliğini artırır, bu da decorator tabanlı doğrulama mantığını geliştirmeyi ve sürdürmeyi kolaylaştırır.
• Decorator'larınızı Kapsamlı Bir Şekilde Test Edin: Decorator'larınızın doğru çalıştığından ve farklı senaryoları uygun şekilde ele aldığından emin olmak için birim testleri yazın.

Gerçek Dünya Örnekleri ve Kullanım Senaryoları

Decorator'ların parametre doğrulaması için nasıl kullanılabileceğine dair bazı gerçek dünya örnekleri şunlardır:

• API İstek Doğrulaması: Decorator'lar, gelen API istek parametrelerini doğrulamak için kullanılabilir, böylece beklenen veri türlerine ve formatlarına uymaları sağlanır. Bu, arka uç mantığınızda beklenmedik davranışları önler. Bir API uç noktasının username, email ve password gibi parametrelerle bir kullanıcı kayıt isteği beklediği bir senaryo düşünün. Decorator'lar, bu parametrelerin mevcut olduğunu, doğru türde (string) olduğunu ve belirli formatlara (örneğin, düzenli ifade kullanarak e-posta adresi doğrulaması) uyduğunu doğrulamak için kullanılabilir.
• Form Girdi Doğrulaması: Decorator'lar, form girdi alanlarını doğrulamak için kullanılabilir, böylece kullanıcıların geçerli veriler girmesi sağlanır. Örneğin, bir posta kodu alanının belirli bir ülke için geçerli bir posta kodu formatı içerdiğini doğrulamak.
• Veritabanı Sorgu Doğrulaması: Decorator'lar, veritabanı sorgularına aktarılan parametreleri doğrulamak için kullanılabilir, bu da SQL enjeksiyonu güvenlik açıklarını önler. Kullanıcı tarafından sağlanan verilerin bir veritabanı sorgusunda kullanılmadan önce uygun şekilde temizlendiğinden emin olmak. Bu, veri türlerini, uzunluklarını ve formatlarını kontrol etmenin yanı sıra, kötü amaçlı kod enjeksiyonunu önlemek için özel karakterleri kaçırmayı içerebilir.
• Yapılandırma Dosyası Doğrulaması: Decorator'lar, yapılandırma dosyası ayarlarını doğrulamak için kullanılabilir, böylece kabul edilebilir aralıklarda ve doğru türde olduklarından emin olunur.
• Veri Serileştirme/Seri Çözme: Decorator'lar, serileştirme ve seri çözme işlemleri sırasında verileri doğrulamak için kullanılabilir, bu da veri bütünlüğünü sağlar ve veri bozulmasını önler. JSON verisinin işlenmeden önce yapısını doğrulamak, gerekli alanları, veri türlerini ve formatları zorunlu kılmak.

Decorator'ları Diğer Doğrulama Teknikleriyle Karşılaştırma

Decorator'lar parametre doğrulaması için güçlü bir araç olsa da, diğer doğrulama tekniklerine kıyasla güçlü ve zayıf yönlerini anlamak önemlidir:

• Manuel Doğrulama: Manuel doğrulama, doğrulama mantığını doğrudan fonksiyonların içine yazmayı içerir. Bu yaklaşım, özellikle karmaşık doğrulama kuralları için sıkıcı ve hataya açık olabilir. Decorator'lar daha bildirimsel ve yeniden kullanılabilir bir yaklaşım sunar.
• Doğrulama Kütüphaneleri: Doğrulama kütüphaneleri, önceden oluşturulmuş bir dizi doğrulama fonksiyonu ve kuralı sunar. Bu kütüphaneler faydalı olabilirken, decorator'lar kadar esnek veya özelleştirilebilir olmayabilirler. Joi veya Yup gibi kütüphaneler tüm nesneleri doğrulamak için şemalar tanımlamak için mükemmeldir, oysa decorator'lar bireysel parametreleri doğrulamada üstündür.
• Middleware (Ara Yazılım): Middleware, genellikle web uygulamalarında istek doğrulaması için kullanılır. Middleware tüm istekleri doğrulamak için uygun olsa da, decorator'lar bireysel fonksiyon parametrelerinin daha ayrıntılı doğrulaması için kullanılabilir.

Sonuç

JavaScript decorator'ları, parametre doğrulamasını uygulamak için güçlü ve zarif bir yol sunar. Decorator'ları kullanarak kod okunabilirliğini artırabilir, tekrarlayan kodu azaltabilir, kodun yeniden kullanılabilirliğini artırabilir ve doğrulama mantığını temel iş mantığından ayırabilirsiniz. API'ler, web uygulamaları veya diğer yazılım türleri oluşturuyor olun, decorator'lar veri bütünlüğünü sağlamanıza ve daha sağlam ve sürdürülebilir kod oluşturmanıza yardımcı olabilir.

Decorator'ları keşfederken, en iyi uygulamaları takip etmeyi, gerçek dünya örneklerini göz önünde bulundurmayı ve özel ihtiyaçlarınız için en iyi yaklaşımı belirlemek üzere decorator'ları diğer doğrulama teknikleriyle karşılaştırmayı unutmayın. Decorator'lar ve parametre doğrulamasındaki uygulamaları hakkında sağlam bir anlayışla, JavaScript kodunuzun kalitesini ve güvenilirliğini önemli ölçüde artırabilirsiniz.

Ayrıca, decorator'lar için yerel destek sunan TypeScript'in artan şekilde benimsenmesi, bu tekniği modern JavaScript geliştirmesi için daha da çekici hale getirmektedir. Parametre doğrulaması için decorator'ları benimsemek, daha temiz, daha sürdürülebilir ve daha sağlam JavaScript uygulamaları yazmaya yönelik bir adımdır.